Skip to content

feat(SelectTree): add ShowSearch parameter #5037

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Jan 4, 2025
Merged

feat(SelectTree): add ShowSearch parameter #5037

merged 4 commits into from
Jan 4, 2025

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 4, 2025 •
edited by sourcery-ai bot
Loading

add ShowSearch parameter

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符；如果有关联 Issue 请在下方填写相关编号

Description

fixes #5036

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

New Features:

  • Added a search bar to the SelectTree component.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 4, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request introduces a new ShowSearch parameter to the SelectTree component, allowing developers to control the visibility of the search bar. It also includes related parameters for search customization, such as IsFixedSearch to fix the search bar's position and ShowResetSearchButton to control the visibility of the search reset button. Unit tests and styling adjustments are included to support these new features.

Class diagram showing updated SelectTree component

classDiagram
    class SelectTree~TValue~ {
        +bool ShowSearch
        +bool IsFixedSearch
        +bool ShowResetSearchButton
        +string SelectTreeCustomClassString
        +bool IsEditable
    }
    note for SelectTree~TValue~ "Added new search-related parameters"

    class TreeView~TItem~ {
        +string ClassString
        +bool ShowSearch
        +bool IsFixedSearch
        +bool ShowResetSearchButton
    }

    SelectTree ..> TreeView : uses
Loading

File-Level Changes

Change Details Files
Added ShowSearch parameter and related search customization options.
  • Added ShowSearch, IsFixedSearch, and ShowResetSearchButton parameters to the SelectTree component.
  • Added unit tests to verify the functionality of the new search parameters.
  • Updated the TreeView component to support the new search parameters.
  • Applied styling changes to accommodate the search bar and its related elements within the SelectTree and TreeView components.
  • Updated the class names for the tree view to include "scroll" by default and conditionally add "is-fixed-search".
 src/BootstrapBlazor/Components/Select/SelectTree.razor
src/BootstrapBlazor/Components/Select/SelectTree.razor.cs
test/UnitTest/Components/SelectTreeTest.cs
src/BootstrapBlazor/Components/TreeView/TreeView.razor
src/BootstrapBlazor/Components/TreeView/TreeView.razor.cs
Updated CSS styles for the SelectTree and TreeView components.
  • Added styles for the search bar, including padding, background color, and sticky positioning when IsFixedSearch is enabled.
  • Adjusted the max height of the dropdown menu and tree view to accommodate the search bar.
  • Added styles for the search reset button.
 src/BootstrapBlazor/Components/Select/SelectTree.razor.scss
src/BootstrapBlazor/Components/TreeView/TreeView.razor.scss
Minor updates and fixes.
  • Updated unit tests to reflect changes in CSS class names.
  • Updated the SelectTree component to use a custom class string for improved styling control.
  • Removed the "scroll" class from the tree root element in the TreeView component and added it to the base class name.
 test/UnitTest/Components/TreeViewTest.cs
src/BootstrapBlazor/Components/Select/SelectTree.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#5036 Add ShowSearch parameter to SelectTree component ✅

Possibly linked issues

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added the enhancement New feature or request label Jan 4, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 4, 2025
@ArgoZhang ArgoZhang enabled auto-merge (squash) January 4, 2025 15:41
sourcery-ai[bot]
sourcery-ai bot approved these changes Jan 4, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link

codecov bot commented Jan 4, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (8b7cc2a) to head (3fe1674).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff            @@
##              main     #5037   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          631       631           
  Lines        27951     27957    +6     
  Branches      4006      4006           
=========================================
+ Hits         27951     27957    +6

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ArgoZhang ArgoZhang merged commit 7fa251c into main Jan 4, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-select-true branch January 4, 2025 15:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] approved these changes

Assignees

@ArgoZhang ArgoZhang

Labels

enhancement New feature or request

Projects

None yet

Milestone

v9.2.0

Development

Successfully merging this pull request may close these issues.

feat(SelectTree): add ShowSearch parameter

2 participants

@ArgoZhang